PHPC-2474: BinaryVector support #1853
Conversation
There was a problem hiding this comment.
In the python implementation, the Binary class has a from_vector static method. You have certainly considered this solution, of having only a factory method instead of a new class. But the new methods toArray and getVectorType are specific to this binary type, so having a dedicated class makes sense. But if you create a new Binary($raw, Binary::TYPE_VECTOR) instance with the vector type from the raw binary data, you don't have this methods. The current state doesn't allow creating a BinaryVector from raw data. I think you would have to wrap in into a BSON Document and encode/decode it to get a BinaryVector instance. I don't find any other binary type that would require a specific class.
I see 3 possible implementations:
- Add
Binary::fromVector(array $vector, VectorType $vectorType)andtoArray()to the existingBinaryclass CreateBinaryVectorclass that extendsBinary(current state of this PR).CreateBinaryVectorclass that implementsBinaryInterface, \JsonSerializable, Type, \Stringable.
We need to compare pro/con of each solution.
jmikola
force-pushed
the
phpc-2474-vector
branch
from
7843292 to
3bf3458
Compare
jmikola
force-pushed
the
phpc-2474-vector
branch
2 times, most recently
from
726240f to
6ffd63d
Compare
jmikola
force-pushed
the
phpc-2474-vector
branch
from
4df67fd to
1649670
Compare
|
One failing test appears to be from Atlas connectivity tests failing to connect to a serverless cluster. Per PHPLIB-1667, I expect that should have been removed; however, I don't see a related PHPC ticket. Please review ignoring that particular test failure and I'll address that with a separate PR and ticket. |
tests/bson/bson-vectortype-001.phpt
Outdated
| var_dump(MongoDB\BSON\VectorType::Float32); | ||
| var_dump(MongoDB\BSON\VectorType::Int8); | ||
| var_dump(MongoDB\BSON\VectorType::PackedBit); |
There was a problem hiding this comment.
To get all the cases:
| var_dump(MongoDB\BSON\VectorType::Float32); | |
| var_dump(MongoDB\BSON\VectorType::Int8); | |
| var_dump(MongoDB\BSON\VectorType::PackedBit); | |
| var_dump(MongoDB\BSON\VectorType::cases()); |
There was a problem hiding this comment.
I assume cases() returns everything in the declaration order (from the stub/header), but I'm not sure if that's an implementation detail. A more robust solution might be to construct an ordered list of test cases and then do a separate assertion to ensure it's consistent with what cases() returns.
There was a problem hiding this comment.
From the documentation:
This method will return a packed array of all cases in an enumeration, in order of declaration.
So you don't have to sort them.
There was a problem hiding this comment.
var_dump(VectorType::cases());array(3) {
[0]=>
enum(VectorType::Float32)
[1]=>
enum(VectorType::Int8)
[2]=>
enum(VectorType::PackedBit)
}
22ddb35 to
acc9413
Compare
| --FILE-- | ||
| <?php | ||
|
|
||
| foreach (VectorType::cases() as $case) { |
There was a problem hiding this comment.
Note: added usage of cases().
| @@ -0,0 +1,18 @@ | |||
| --TEST-- | |||
| MongoDB\BSON\Binary unserialization requires valid vector data (__serialize and __unserialize) | |||
There was a problem hiding this comment.
Note: this complements bson-binary-set_state_error-004.phpt
https://jira.mongodb.org/browse/PHPC-2474